/*
 * MIT License
 *
 * Copyright (c) 2024-2048 冰羽
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package cn.star.framework.rbac.service;

/** Spring Security {@link PasswordEncoder} */
public interface PasswordEncoderService {

  /**
   * Encode the raw password. Generally, a good encoding algorithm applies a SHA-1 or greater hash
   * combined with an 8-byte or greater randomly generated salt.
   */
  String encode(CharSequence rawPassword);

  /**
   * Verify the encoded password obtained from storage matches the submitted raw password after it
   * too is encoded. Returns true if the passwords match, false if they do not. The stored password
   * itself is never decoded.
   *
   * @param rawPassword the raw password to encode and match
   * @param encodedPassword the encoded password from storage to compare with
   * @return true if the raw password, after encoding, matches the encoded password from storage
   */
  boolean matches(CharSequence rawPassword, String encodedPassword);

  /**
   * Returns true if the encoded password should be encoded again for better security, else false.
   * The default implementation always returns false.
   *
   * @param encodedPassword the encoded password to check
   * @return true if the encoded password should be encoded again for better security, else false.
   */
  default boolean upgradeEncoding(String encodedPassword) {
    return false;
  }
}
